home *** CD-ROM | disk | FTP | other *** search
/ EnigmA Amiga Run 1996 February / EnigmA AMIGA RUN 04 (1996)(G.R. Edizioni)(IT)[!][issue 1996-02][Skylink CD III].iso / earcd / comm2 / thrashbr.lha / ThrashBar / TBar1.1.Dox < prev   
Text File  |  1980-10-04  |  14KB  |  319 lines
  1.                         __      __                    ___    ___
  2.                /\  __  |__|____|__|_ ___________ _____\  \  /  /
  3.               /  \|  \ \    _ _    /|  \  ____  \ __  \\  \/  /
  4.              /    \   \|\  // \\  /_|  |\/___/  //  \  \\    /
  5.          __ /  /\  \     \//   \\/ _   |  _   _// DW \  \    \
  6.         /  \__/__\  \|\   |     \ | |  | / \  \ \____/  / /\  \_
  7.         \___________/| \__|______\| |__|/   \__\_______/ /  \__/
  8.          /__/     |__|         |__| /__/             /__/
  9.  
  10.                     Presents:
  11.  
  12.            Another AmiExpress Utility By Thrash! << NOTE!
  13.  
  14.       FIRSTLY A CHANGE OF NAME... THIS UTIL WAS ORIGINALLY CALLED TBAR
  15.       HOWEVER DUE TO SOME AMUSING PEOPLE ASKING QUESTION TO THE WRONG
  16.                       PEOPLE IT IS NOW RENAMED TO:
  17.  
  18.  
  19.  
  20.                  THRASH/ATX FUCKIN CODED THIS - BAR V1.01
  21.                  (OR TBAR FOR SHORT HEHE!)
  22.  
  23.  
  24.  
  25.           THIS UTILITY CANNOT BE SOLD IN ANY FORM
  26.             BY PUBLIC DOMAIN LIBRARIES!
  27.  
  28.  
  29.  WHAT IS TBAR?
  30.  =============
  31.     Basically, Tbar is a multiple chart displayer for use with ANY
  32. Version of Ami-Express. Use it to compile upto 6 different types of chart,
  33. (ansi or non-ansi), which display information on any amount of users on your
  34. bulletin board in a bar-chart format that is easy to read. Noteable features
  35. built into it are:
  36.  
  37.  o 100% Assembly Language. (Each Chart only takes about 1 sec. to compile)
  38.  o Top Byte Uploaders Chart.
  39.  o Top Byte DownLoaders Chart.
  40.  o Top File Uploaders Chart.
  41.  o Top File DownLoaders Chart.
  42.  o Top Message Writers Chart.
  43.  o Top Callers Chart.
  44.  o Overall status of bulletin board users.
  45.  o Configurable Ratios for calculation of elite/normal/leech guys.
  46.  
  47. Optional Features:
  48.  
  49.  o Ansi mode on/off (yes - you can still see the bars in non-ansi!).
  50.  o Individual logos/headertexts for each chart.
  51.  o Excluded users file (for people you dont want shown in charts). This
  52.    will handle security levels as well as names.
  53.  o One of upto 255 random lines will appear underneath your chart.
  54.  
  55.  
  56.  WHY RUN TBAR?
  57.  =============
  58.     Before you throw this util into the bottomless pile of crap utils
  59. that get released for Ami-Express, or even goto the trouble of setting it
  60. all up only to find you dont like the bloody thing. Stop! Included in this
  61. archive are example outputs for you to view. They are ansi versions so make
  62. sure you use an 8 colour CLI window to look at them if you want to see them
  63. in their full glory! If you're happy after that then continue reading. If
  64. not then stick to that lame "C" version you're currently using that takes
  65. about 30 seconds to execute! (unless you already use TTOP that is hehe).
  66.  
  67.     Lets face it, the main problem about Ami-Express utils is that there
  68. are so bloody many of them! Some are really great but I'd say that about
  69. 80% arent worth shit. Even those that are really good, sometimes fall down
  70. on the fact that they LOOK crap. This is one thing I hope to have eliminated
  71. from my /Xpress utilities. The original ansi design was done by Pot-Noodle
  72. and most sysops seem to agree that it is one of the best and easiest to look
  73. at. I hope you agree!
  74.     If there IS something you think is missing from this utility, then
  75. for fuck sake lemme know! I cant do shit without being told about it. (A
  76. few bbs's I'm on are listed at the bottom of this file). This also goes for
  77. if you dont like the LOOK of TBar. Draw up a design and gimme!. Most of
  78. my utilities are constantly being updated because people ASK me to do some-
  79. thing and I (being a nice kinda guy?) do it.
  80.     Ok, enough shit... on with the show.
  81.  
  82.  
  83. HOW TO INSTALL TBAR:
  84. ====================
  85.     In its very simplest form, Tbar requires NO setting up at all.
  86. However, if you spend the time to study these documents fully, I'm sure
  87. you'll find all the options that most sysops require nowadays.
  88.     To see a basic output from Tbar simply type the following into
  89. an 8 colour CLI window:
  90.  
  91. TBAR UPLD BBS:USER.DATA 010 5
  92.  
  93. where "UPLD" is the chart you want to be compiled (see later in this docu-
  94. ment under "WHICH CHART TO OUTPUT") and "BBS:USER.DATA" is the FULL path
  95. and name of your Ami-Express UserData file.
  96.     (A few people reading this will know that if I had wanted to, I could
  97. have discovered the name of the userdata file by loading up the ACP.STARTUP
  98. file. The problem with this is that so many people DONT know how to use the
  99. ACP file correctly and just use it for starting the nodes. Maybe in a future
  100. version of /Xpress, when people HAVE to use the ACP correctly, I will add 
  101. this simple feature).
  102.  
  103.  
  104. RE-DIRECTION:
  105. =============
  106.     TBar itself, will NOT create a file of the text displayed. Why write
  107. the routines when Commodore have done it already? Yeah, you guessed it. You
  108. yourself will have to re-direct the file to the appropriate bulletin text.
  109. This redirection will obviously have to come BEFORE any of the commandline
  110. options of TBar itself. In case you haven't done this before (your kidding
  111. me?), I'll quickly explain. Here is a command line to try going on from the
  112. first example.
  113.  
  114. TBAR >Ram:TBarOutput UPLD BBS:USER.DATA 010 5
  115.  
  116.     This will force TBar to send all text displayed to a file created
  117. in "ram:" which is called "TBarOutput" instead of the normal CLI window.
  118. There - need I say more? If more information is required on Bulletin texts
  119. and how they work within ami-express please refer to your ami-express
  120. documentation.
  121.  
  122.     Here are the the commandline options IN ORDER
  123.  
  124.  
  125. WHICH CHART YOU WANT:
  126. =====================
  127.     The chart option must ALWAYS be the first command in the command-
  128. line. There are six charts to choose from and simply changing the four
  129. letters at the beginning will tell TBar what chart you require. Those
  130. available to you are:
  131.  
  132.     UPLD    -    Top byte uploaders
  133.     DNLD    -    Top byte downloaders
  134.     UPFL    -    Top file uploaders
  135.     DNFL    -    Top file downloaders
  136.     MESG    -    Top message writers
  137.     CALL    -    Top callers chart
  138.  
  139.  
  140. YOUR USERDATA:
  141. ==============
  142.     The FULL path and name of your userdata file must ALWAYS be set
  143. after the TBar has been told which chart you want. If you are a person
  144. who has changed the userdata filename to something like "USER DATA" for
  145. safety reasons, then you will have to make a copy of it into ram: or some
  146. where as TBar will not (at this time) handle filenames with spaces in them.
  147. Maybe in the next version eh!
  148.  
  149.  
  150. HOW MANY USERS TO DISPLAY:
  151. ==========================
  152.     Tbar determines the amount of users to display in the chart by the
  153. three (T*H*R*E*E,3) digit figure that must ALWAYS follow the userdata file
  154. in the command line. If the amount of users to be displayed is less than
  155. 100 then padding zeros MUST be used. Going from the first example, here are
  156. a few more of the same type but with different amount of users.
  157.  
  158. TBAR UPLD BBS:USER.DATA 010 5        Display top 10 byte uploaders
  159. TBAR MESG BBS:USER.DATA 025 5        Display top 25 message writers
  160. TBAR UPFL BBS:USER.DATA ALL 5        Display ALL users sorted in files
  161.                     Uploaded format.
  162.  
  163. RATIO CALCULATION:
  164. ==================
  165.     The Ratio is used in a quick calculation to determine if that
  166. particular user has leeched or benefitted the bbs. It works exactly the
  167. same way as the ratio in the users statistics. The ratio number must
  168. ALWAYS be a number between 2 and 9 and must ALWAYS follow straight after
  169. the amount of users to be displayed. IE
  170.  
  171. TBAR UPLD BBS:USER.DATA 010 3        Top 10, ratio 3/1 calculation
  172. TBAR UPLD BBS:USER.DATA 010 7        Top 10, ratio 7/1 calculation
  173.  
  174. NOTE:    The calculation is always performed on the uploaded and downloaded
  175.     BYTES. Ie if you choose UPFL (uploaded files chart), then the ratio
  176.     calcualtion WILL NOT be performed on the FILES uploaded.
  177.  
  178.  
  179. NON-ANSI MODE:
  180. ==============
  181.     Some sysops may want this utility to be displayed to ALL users
  182. when they logon. The problem is that they may logon to the bbs in non-ansi
  183. mode and if the normal chart is displayed in non-ansi there are just a load
  184. of blank spaces where the bars are normally displayed. As far as I know, most
  185. other (if not all) barchart displayers haven't taken this into account and
  186. so sysops just dont bother to run barcharts. This all stops from NOW!
  187.     If, at the end of your command line, you place a "-A", all coloured
  188. spaces within the barchart section will be replaced with a "#" so that
  189. ANYBODY can see the chart. You would obviously need to run TBar twice in your
  190. logff script. Once for ansi ON and another time with Ansi OFF. Here's an
  191. example of a logoff script:
  192.  
  193. TBAR >BBS:CONF1/BULL100.TXT UPLD BBS:USER.DATA 010 3 -A  (Ansi-OFF)
  194. TBAR >BBS:CONF1/BULL100.TXT.GR UPLD BBS:USER.DATA 010 3  (Ansi-ON)
  195.  
  196.  
  197.  
  198.     Right, that's all the commandline finished with but what about your
  199. logos, random line selection bits and excluded users file? All of these
  200. are OPTIONAL and if they dont exist, TBar will carry on as normal.
  201.  
  202. DISPLAYING LOGO/HEADERTEXTS:
  203. ============================
  204.     Tbar will simply use the four-letter chart option to get a logo or
  205. headerfile from your S: directory. If the file isn't found - it wont get
  206. displayed!
  207.  
  208.     CHART        TBAR SEARCHES FOR
  209.     =====        =================
  210.     UPLD        S:TBARUPLD.HEADER    <- UpLoaded Bytes Logo
  211.     DNLD        S:TBARDNLD.HEADER    <- DownLoaded bytes Logo
  212.     UPFL        S:TBARUPFL.HEADER    <- UpLoaded files Logo
  213.     DNFL        S:TBARDNFL.HEADER    <- DownLoaded Files Logo
  214.     MESG        S:TBARMESG.HEADER    <- Top MessageWriters Logo
  215.     CALL        S:TBARCALL.HEADER    <- Top Callers Logo
  216.  
  217.     It doesn't matter if the texts are ansi-coloured as Ami-Express has
  218. a built in stripper if the user is in non-ansi. If you find this method of
  219. logo detection too restricting then please feel free to let me know and in
  220. a future release I will possibly change it.
  221.  
  222. RANDOM LINES:
  223. =============
  224.     This is a nice feature that I first saw used in Amilog coded by
  225. Retaliator/Anthrox so cheers to him and Pot-noodle for being so inventive!
  226.     After TBar has displayed both the logo/headertext and the main chart
  227. itself, it will search for a file called "S:TBAR.LINES". An example file is
  228. included in this archive so check it out! The file is simply a text file of
  229. upto 255 one liners. TBar will randomly select one of these and place it
  230. underneath the chart. Simple but effective. Each line MUST NOT be longer 
  231. then 76 characters and MUST end in a return (otherwise TBar wont find the
  232. required line!). If you put more than 255 lines these will be ignored. Once
  233. again, if TBar fails to find the file it DOESN'T MATTER. It simply wont use
  234. a random line.
  235.  
  236.  
  237. EXCLUDED USERS FILE:
  238. ====================
  239.     This is where I've heard some people felt that TTOP fell down. TTOP
  240. version 2 will be released in the first 3 months on '93 so look out for it!
  241. The file Tbar searches for is called "S:TBAR.EXCLUDES". This is simply a file
  242. of people you DO NOT want included in the following charts:
  243.  
  244.     UPLD    -    Top byte uploaders
  245.     DNLD    -    Top byte downloaders
  246.     UPFL    -    Top file uploaders
  247.     DNFL    -    Top file downloaders
  248.  
  249. The names in the file must be EXACTLY as they are written in the userdata
  250. file and each one MUST end with a return.
  251.     These people are not actually excluded from the chart altogether.
  252. All TBar does is zero their uploaded bytes/files and their downloaded
  253. bytes/files. If you use the "ALL" option they WILL get displayed but
  254. obviously they will be at the bottom of the chart. It is upto the sysop
  255. to place the correct number in the commandline so that these people do
  256. not get show on the wrong chart!
  257.  
  258. NOTE:    These peoples up/downloads WILL NOT be included in any chart in
  259.     the OVERALL stats line that appears at the bottom.
  260. ============================================================================
  261. UPDATE ON EXCLUDED USERS FILE:
  262. =============================-
  263.     Thanks to the suggestion of Sigma7/Abandon, you can now also 
  264. exclude people by their SECURITY LEVEL. Simply use the following line
  265. in the file "S:TBAR.EXCLUDES".
  266.  
  267. Sec_Level XXX
  268.  
  269.     Note that as in the main command line, the XXX must be a THREE
  270. digit figure corresponding to the security levels you want excluded. If
  271. the security level is less than 100 then PADDING ZEROS MUST BE USED!
  272.  
  273. Sec_Level 010    - exclude people whose security level is 10.
  274. ============================================================================
  275.  
  276. FINAL WORDS:
  277. ============
  278.  
  279.     Well, thats about it!.. All thats left is to leave you with a list
  280. of bulletin boards whose sysops have been a great help during production.
  281. Remember you can reach me on these boards, so if there's sommit you wanna
  282. see in a future release or get off your chest, then leave a message to 
  283. either me or the sysop.
  284.  
  285.     C.A.L        +44(0)81-3466842    Sysop - Pot-Noodle/ATX!
  286.     BurgerBar    +44(0)983-741324    Sysop - Ice D/Indy
  287.     Synergy        +49-5731-41982        Sysop - Sigma7/Abandon
  288.     HyperSpace    +49-5916-4755        Sysop - Thargoid/ATX!
  289.     Bad Dreams    +44(0)81-6795693    Sysop - DreamWarrior/Indy
  290.     Arcadia        +44(0)923-893593    Sysop - Beast/Qtx
  291.     EnterPrise    +01-4122332611        Sysop - Picard/ATX!
  292.  
  293. ============================================================================
  294. VERSION 1.01 UPDATE:
  295. ====================
  296.     Sorry but there was a hanging bug if you selected UPFL,DNFL,MESG
  297. or CALL and the top user had less then 43 as the answer. The hanging has
  298. now been fixed however TBar will NOT show a true representation until the
  299. top user has MORE than 43 as the answer. (ie 44 messages,calls etc depending
  300. on the chart selected). Thanks to the people who reported this - it was
  301. not quickly discovered because sysops with numbers below 43 in the user data
  302. must have only just started there bbs and all of my bug-testers have been
  303. going for years! I will update to show true represention soon!
  304.  
  305.     Also to keep up with TTop, the ansi part depicting bytes up/down-
  306. loaded has now been extended to handle 10 characters instead of 12. Only
  307. needed by a few boards but needed nevertheless!
  308.  
  309. HISTORY:
  310. ========
  311.  
  312. V0.05    08/11/92 (ßeta)    First ßeta version to testers.
  313. V0.08    25/11/92 (ßeta)    Added logo selection,random lines
  314.             and excluded file to options
  315. V0.09    1/12/92     (ßeta) Exclusion file will now handle
  316.             security levels.
  317. V1.00    15/01/93     First public release.
  318. V1.01    12/04/93        Hanging Loop bug fixed. Characters extended.
  319.